<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>FlowController xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/totsp/gwittir/client/flow/FlowController.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * FlowController.java</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Created on May 9, 2007, 6:29 PM</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * To change this template, choose Tools | Template Manager</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * and open the template in the editor.</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> */</em>
<a name="9" href="#9">9</a>   <strong class="jxr_keyword">package</strong> com.totsp.gwittir.client.flow;
<a name="10" href="#10">10</a>  
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a name="12" href="#12">12</a>  <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a name="13" href="#13">13</a>  
<a name="14" href="#14">14</a>  <strong class="jxr_keyword">import</strong> com.google.gwt.user.client.History;
<a name="15" href="#15">15</a>  <strong class="jxr_keyword">import</strong> com.google.gwt.user.client.HistoryListener;
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">import</strong> com.google.gwt.user.client.ui.HasWidgets;
<a name="17" href="#17">17</a>  <strong class="jxr_keyword">import</strong> com.google.gwt.user.client.ui.Panel;
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> com.google.gwt.user.client.ui.SimplePanel;
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> com.google.gwt.user.client.ui.Widget;
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> com.totsp.gwittir.client.ui.BoundWidget;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> com.totsp.gwittir.client.ui.HasWidget;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The FlowController class is used to register FlowContexts to Widget maps for</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * page to page or wizard style application flows. See the package doc for details.</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> *</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:cooper@screaming-penguin.com" target="alexandria_uri">mailto:cooper@screaming-penguin.com</a>"&gt;Robert "kebernet" Cooper&lt;/a&gt;</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> */</em>
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/totsp/gwittir/client/flow/FlowController.html">FlowController</a> {
<a name="30" href="#30">30</a>      <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> HashMap&lt;Object, FlowContext&gt; contexts = <strong class="jxr_keyword">new</strong> HashMap&lt;Object, FlowContext&gt;();
<a name="31" href="#31">31</a>      <strong class="jxr_keyword">static</strong> <a href="../../../../../com/totsp/gwittir/client/flow/HistoryManager.html">HistoryManager</a> manager = <strong class="jxr_keyword">null</strong>;
<a name="32" href="#32">32</a>      <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> HistoryListener hl = <strong class="jxr_keyword">new</strong> HistoryListener() {
<a name="33" href="#33">33</a>              <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onHistoryChanged(String historyToken) {
<a name="34" href="#34">34</a>                  <strong class="jxr_keyword">if</strong>(manager != <strong class="jxr_keyword">null</strong>) {
<a name="35" href="#35">35</a>                      manager.apply(historyToken);
<a name="36" href="#36">36</a>                  }
<a name="37" href="#37">37</a>              }
<a name="38" href="#38">38</a>          };
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>      <strong class="jxr_keyword">static</strong> {
<a name="41" href="#41">41</a>          History.addHistoryListener(hl);
<a name="42" href="#42">42</a>      }
<a name="43" href="#43">43</a>  
<a name="44" href="#44">44</a>      <em class="jxr_javadoccomment">/**</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     *  Calls a new flow context name, from the sender context with the given object model.</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">     * @param sender The lowest level widget to begin looking for the name</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">     * @param name The activity name to look for</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     * @param model The model object to pass to the registered BoundWidget</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     * @return boolean indicating whether the call resulted in a state change.</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     */</em>
<a name="51" href="#51">51</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> call(Widget sender, String name, Object model) {
<a name="52" href="#52">52</a>      	<strong class="jxr_keyword">return</strong> call(sender, name, model, <strong class="jxr_keyword">true</strong>);
<a name="53" href="#53">53</a>      }
<a name="54" href="#54">54</a>      
<a name="55" href="#55">55</a>      <em class="jxr_javadoccomment">/**</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     *  Calls a new flow context name, from the sender context with the given object model.</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * @param sender The lowest level widget to begin looking for the name</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     * @param name The activity name to look for</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     * @param model The model object to pass to the registered BoundWidget</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * @return boolean indicating whether the call resulted in a state change.</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     */</em>
<a name="62" href="#62">62</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> call(Widget sender, String name, Object model, <strong class="jxr_keyword">boolean</strong> fireEvents) {
<a name="63" href="#63">63</a>          Widget contextRoot = sender;
<a name="64" href="#64">64</a>          <a href="../../../../../com/totsp/gwittir/client/flow/FlowContext.html">FlowContext</a> context = (FlowContext) contexts.get(contextRoot);
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>          <strong class="jxr_keyword">while</strong>((context == <strong class="jxr_keyword">null</strong>) &amp;&amp; (contextRoot != <strong class="jxr_keyword">null</strong>)) {
<a name="67" href="#67">67</a>              contextRoot = contextRoot.getParent();
<a name="68" href="#68">68</a>              context = (FlowContext) contexts.get(contextRoot);
<a name="69" href="#69">69</a>          }
<a name="70" href="#70">70</a>  
<a name="71" href="#71">71</a>          <strong class="jxr_keyword">if</strong>(context == <strong class="jxr_keyword">null</strong> || !(contextRoot instanceof HasWidgets || contextRoot instanceof <a href="../../../../../com/totsp/gwittir/client/ui/HasWidget.html">HasWidget</a> )) {
<a name="72" href="#72">72</a>              <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(
<a name="73" href="#73">73</a>                  <span class="jxr_string">"Unknown destination name for this elements context."</span>);
<a name="74" href="#74">74</a>          }
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>          Object panel = contextRoot;
<a name="77" href="#77">77</a>          BoundWidget&lt;?&gt; widget = context.get(name);
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>          <strong class="jxr_keyword">if</strong>(widget == <strong class="jxr_keyword">null</strong>) {
<a name="80" href="#80">80</a>              <strong class="jxr_keyword">return</strong> call(contextRoot.getParent(), name, model);
<a name="81" href="#81">81</a>          }
<a name="82" href="#82">82</a>          <strong class="jxr_keyword">if</strong>( model != <strong class="jxr_keyword">null</strong> ){
<a name="83" href="#83">83</a>              widget.setModel(model);
<a name="84" href="#84">84</a>          }
<a name="85" href="#85">85</a>          BoundWidget&lt;?&gt; old = <strong class="jxr_keyword">null</strong>;
<a name="86" href="#86">86</a>          
<a name="87" href="#87">87</a>  
<a name="88" href="#88">88</a>          <strong class="jxr_keyword">if</strong>( panel instanceof SimplePanel ){
<a name="89" href="#89">89</a>              SimplePanel sp = (SimplePanel) panel;
<a name="90" href="#90">90</a>              <strong class="jxr_keyword">if</strong>( sp.getWidget() instanceof BoundWidget ){
<a name="91" href="#91">91</a>                  old = (BoundWidget&lt;?&gt;) sp.getWidget();
<a name="92" href="#92">92</a>              }
<a name="93" href="#93">93</a>              sp.setWidget( (Widget) widget );
<a name="94" href="#94">94</a>          } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>( panel instanceof HasWidget ){
<a name="95" href="#95">95</a>              <a href="../../../../../com/totsp/gwittir/client/ui/HasWidget.html">HasWidget</a> hw = (HasWidget) panel;
<a name="96" href="#96">96</a>              <strong class="jxr_keyword">if</strong>( hw.getWidget() instanceof BoundWidget ){
<a name="97" href="#97">97</a>                  old = (BoundWidget&lt;?&gt;) hw.getWidget();
<a name="98" href="#98">98</a>              }
<a name="99" href="#99">99</a>              hw.setWidget( (Widget) widget );
<a name="100" href="#100">100</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>( panel instanceof HasWidgets ){
<a name="101" href="#101">101</a>             HasWidgets hw = (HasWidgets) panel;
<a name="102" href="#102">102</a>             Iterator&lt;Widget&gt; it = hw.iterator();
<a name="103" href="#103">103</a>             <strong class="jxr_keyword">while</strong>(it.hasNext()) {
<a name="104" href="#104">104</a>                 Object next = it.next();
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>                 <strong class="jxr_keyword">if</strong>(next instanceof <a href="../../../../../com/totsp/gwittir/client/ui/BoundWidget.html">BoundWidget</a>) {
<a name="107" href="#107">107</a>                     old = (BoundWidget&lt;?&gt;) next;
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>                     <strong class="jxr_keyword">break</strong>;
<a name="110" href="#110">110</a>                 }
<a name="111" href="#111">111</a>             }
<a name="112" href="#112">112</a>             hw.clear();
<a name="113" href="#113">113</a>             hw.add((Widget) widget );
<a name="114" href="#114">114</a>         }
<a name="115" href="#115">115</a>         <a href="../../../../../com/totsp/gwittir/client/flow/FlowEvent.html">FlowEvent</a> event = context.createEvent(contextRoot, name, widget, old );
<a name="116" href="#116">116</a>         <strong class="jxr_keyword">if</strong>(fireEvents){
<a name="117" href="#117">117</a> 	        context.fireEvent(event);
<a name="118" href="#118">118</a>         }
<a name="119" href="#119">119</a> 	        
<a name="120" href="#120">120</a> 	    manager.transition(event, fireEvents);
<a name="121" href="#121">121</a> 	      
<a name="122" href="#122">122</a>         
<a name="123" href="#123">123</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="124" href="#124">124</a>     }
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a>     <em class="jxr_javadoccomment">/**</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     * Finds the first managed widget/panel from a source widget that has a name</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * mapped in its flow context</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     * @param widget The low-level widget to search from</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     * @param name The name to search a flow context for</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * @return the Managed widget that matches first.</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     */</em>
<a name="133" href="#133">133</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Widget findContextWidget(Widget widget, String name) {
<a name="134" href="#134">134</a>         Widget contextRoot = widget;
<a name="135" href="#135">135</a>         <a href="../../../../../com/totsp/gwittir/client/flow/FlowContext.html">FlowContext</a> context = (FlowContext) contexts.get(contextRoot);
<a name="136" href="#136">136</a> 
<a name="137" href="#137">137</a>         <strong class="jxr_keyword">while</strong>((context == <strong class="jxr_keyword">null</strong> || context.get(name) == <strong class="jxr_keyword">null</strong>) &amp;&amp; (contextRoot != <strong class="jxr_keyword">null</strong>) ) {
<a name="138" href="#138">138</a>             contextRoot = contextRoot.getParent();
<a name="139" href="#139">139</a>             context = (FlowContext) contexts.get(contextRoot);
<a name="140" href="#140">140</a>         }
<a name="141" href="#141">141</a> 
<a name="142" href="#142">142</a>         <strong class="jxr_keyword">return</strong> contextRoot;
<a name="143" href="#143">143</a>     }
<a name="144" href="#144">144</a>     
<a name="145" href="#145">145</a>     <em class="jxr_javadoccomment">/**</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     * Find the FlowContext with a name mapping from the low level widget</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     * @param widget Widget to begin searching from</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">     * @param name activity name to find</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">     * @return a FlowContext or null.</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     */</em>
<a name="151" href="#151">151</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../com/totsp/gwittir/client/flow/FlowContext.html">FlowContext</a> findContext(Widget widget, String name){
<a name="152" href="#152">152</a>         Widget contextRoot = widget;
<a name="153" href="#153">153</a>         <a href="../../../../../com/totsp/gwittir/client/flow/FlowContext.html">FlowContext</a> context = (FlowContext) contexts.get(contextRoot);
<a name="154" href="#154">154</a> 
<a name="155" href="#155">155</a>         <strong class="jxr_keyword">while</strong>((context == <strong class="jxr_keyword">null</strong> || context.get(name) == <strong class="jxr_keyword">null</strong>) &amp;&amp; (contextRoot != <strong class="jxr_keyword">null</strong>) ) {
<a name="156" href="#156">156</a>             contextRoot = contextRoot.getParent();
<a name="157" href="#157">157</a>             context = (FlowContext) contexts.get(contextRoot);
<a name="158" href="#158">158</a>         }
<a name="159" href="#159">159</a> 
<a name="160" href="#160">160</a>         <strong class="jxr_keyword">return</strong> context;
<a name="161" href="#161">161</a>     }
<a name="162" href="#162">162</a> 
<a name="163" href="#163">163</a>     <em class="jxr_javadoccomment">/**</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     * Returns the current HistoryManager implementation</em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">     * @return the current HistoryManager implementation</em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">     */</em>
<a name="167" href="#167">167</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../com/totsp/gwittir/client/flow/HistoryManager.html">HistoryManager</a> getHistoryManager() {
<a name="168" href="#168">168</a>         <strong class="jxr_keyword">return</strong> FlowController.manager;
<a name="169" href="#169">169</a>     }
<a name="170" href="#170">170</a> 
<a name="171" href="#171">171</a>     <em class="jxr_javadoccomment">/**</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     * Registers a managed widget with the given FlowContext</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">     * @param container the widget to manage</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">     * @param context The FlowContext it maps to.</em>
<a name="175" href="#175">175</a> <em class="jxr_javadoccomment">     */</em>
<a name="176" href="#176">176</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> setFlowContext(HasWidgets container, <a href="../../../../../com/totsp/gwittir/client/flow/FlowContext.html">FlowContext</a> context) {
<a name="177" href="#177">177</a>         contexts.put(container, context);
<a name="178" href="#178">178</a>     }
<a name="179" href="#179">179</a>     
<a name="180" href="#180">180</a>     <em class="jxr_javadoccomment">/**</em>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * Registers a managed widget with the given FlowContext</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">     * @param container the widget to manage</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">     * @param context The FlowContext it maps to.</em>
<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">     */</em>
<a name="185" href="#185">185</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> setFlowContext(<a href="../../../../../com/totsp/gwittir/client/ui/HasWidget.html">HasWidget</a> container, <a href="../../../../../com/totsp/gwittir/client/flow/FlowContext.html">FlowContext</a> context) {
<a name="186" href="#186">186</a>         contexts.put(container, context);
<a name="187" href="#187">187</a>     }
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Registers a history manager for the FlowController globally.</em>
<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">     * </em>
<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">     * @param manager A history manager implementation</em>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">     */</em>
<a name="193" href="#193">193</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> setHistoryManager(<a href="../../../../../com/totsp/gwittir/client/flow/HistoryManager.html">HistoryManager</a> manager) {
<a name="194" href="#194">194</a>         FlowController.manager = manager;
<a name="195" href="#195">195</a>     }
<a name="196" href="#196">196</a> 
<a name="197" href="#197">197</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Unregisters a FlowContext for a manage widget</em>
<a name="198" href="#198">198</a> <em class="jxr_javadoccomment">     * </em>
<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">     * @param container Container to unregister</em>
<a name="200" href="#200">200</a> <em class="jxr_javadoccomment">     * @return boolean if there was a change.</em>
<a name="201" href="#201">201</a> <em class="jxr_javadoccomment">     */</em>
<a name="202" href="#202">202</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> unsetFlowContext(Panel container) {
<a name="203" href="#203">203</a>         <strong class="jxr_keyword">return</strong> contexts.remove(container) != <strong class="jxr_keyword">null</strong>;
<a name="204" href="#204">204</a>     }
<a name="205" href="#205">205</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

